/*
 * Copyright 2009 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.gwt.core.ext.js;

import com.google.gwt.dev.jjs.SourceInfo;
import com.google.gwt.dev.jjs.ast.JField;
import com.google.gwt.dev.jjs.ast.JMethod;
import com.google.gwt.dev.jjs.ast.JProgram;

/**
 * The context for parsing JSNI functions.
 */
public interface JsniFunctionParseContext {

  /**
   * Creates a reference from JavaScript to the specified field.
   */
  JavaRef createJavaRef(JField field, SourceInfo sourceInfo, boolean isLvalue);

  /**
   * Creates a reference from JavaScript to the specified method.
   */
  JavaRef createJavaRef(JMethod method, SourceInfo sourceInfo);

  /**
   * Returns a view of the Java program, useful to resolve references from
   * JavaScript code to Java constructs.
   */
  JProgram getProgram();

  /**
   * Report a parse error in the JS code.
   * 
   * @param startPos the starting character position within the JS code of the
   *          error
   * @param endPos the ending character position within the JS code of the error
   * @param message a user-facing message describing the parse error
   */
  void reportError(SourceInfo sourceInfo, String message);
}
